home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / Timing / WorldTime.lha / WorldTime / WorldTime.doc < prev    next >
Encoding:
Text File  |  1992-11-06  |  8.1 KB  |  187 lines
  1.  
  2.                                WorldTime v2.1
  3.  
  4.                        © Copyright 1992 Jonathan Potter
  5.  
  6.                     This program is freely distributable.
  7.  
  8. -------------------------------------------------------------------------------
  9.  
  10.   This is a completely rewritten version of WorldTime. For those not familiar
  11. with the program, it can show you the time in any city in the world. The
  12. times are calculated automatically using data supplied by the user.
  13.  
  14.   WorldTime 2 has been rewritten to take advantages of features available
  15. under Kickstart 2, and thus will not run under 1.2 or 1.3 anymore. If you
  16. haven't upgraded yet, do so, as you are missing out on many wonderful things
  17. (WorldTime 2 amongst them :-)
  18.  
  19.     WorldTime can be run from the CLI or the Workbench (including the WBStartup
  20. drawer) successfully. If run from the CLI, it detaches automatically so
  21. you do not need RUN.
  22.  
  23.   WorldTime runs as a commodity, and can be hidden and popped up using a
  24. defined hotkey. It takes its arguments via ToolTypes in its icon or from the
  25. CLI line. These arguments are :
  26.  
  27.     CX_POPKEY=<hotkey>            - The hotkey string to use.
  28.                                     default : lalt ralt w
  29.     CX_POPUP=<yes|no>             - Whether to open straight away when run.
  30.                                     default : yes
  31.     CX_PRIORITY=<priority>        - Commodity priority
  32.                                     default : 0
  33.  
  34.     LARGEWINDOW=<x>/<y>/<w>/<h>   - "Large" window dimensions
  35.                                     default : 20/10/400/220
  36.     LOCALCITY=<local city>        - Your local city
  37.                                     default : GMT
  38.     LOCALSUMMERTIME=<start>,<end> - Dates that local summer time begin and end.
  39.                                     default : no summer time
  40.     LOCALTIME=<local time zone>   - Your local timezone (relative to GMT)
  41.                                     default : 0
  42.     SHOWCITY=<city>               - City to display initially
  43.                                     default : first in the list
  44.     ZONEDATAFILE=<date filename>  - File to read time zone data from
  45.                                     default : WorldTime.dat
  46.     ZOOMWINDOW=<x>/<y>/<w>/<h>    - "Zoom" window dimensions
  47.                                     default : 20/10/300/0
  48.  
  49.   CX_POPKEY, CX_POPUP and CX_PRIORITY are all standard commodities arguments.
  50.  
  51.   LARGEWINDOW and ZOOMWINDOW allow you to specify the dimensions of the
  52. window in both its normal (LARGE) and zoomed (ZOOM) state (the zoomed state
  53. is entered by selecting the Zoom gadget in the window's title bar). These are
  54. given in the form <left edge>/<top edge>/<width>/<height>. Illegal dimensions
  55. will be adjusted automatically.
  56.  
  57.   LOCALCITY and LOCALTIME are used to specify your locality. LOCALCITY is a
  58. string representing the name of your location (eg Adelaide). LOCALTIME gives
  59. your locality's time relative to GMT. This is vital information, as this is
  60. used to calculate the times for all the other cities. For example, 9.5
  61. indicates that your locality is nine and a half hours ahead of GMT. -10
  62. indicates you are ten hours behind.
  63.  
  64.   LOCALSUMMERTIME allows you to specify when your locality experiences
  65. summer time (daylight savings). This is given as two dates, giving the
  66. beginning and the end of summer time (for example, 1-Jun,31-Aug). When
  67. WorldTime sees that the current date is within this range, it automatically
  68. adds an hour to your GMT offset. This saves you having to adjust the LOCALTIME
  69. parameter whenever summer time begins or ends.
  70.  
  71.   SHOWCITY allows you to initially display a given city. If given, this will
  72. be positioned at the top of the viewable list. If not, the list will begin
  73. at the top. For example, SHOWCITY=Dallas will begin by displaying Dallas at
  74. the top of the list.
  75.  
  76.   ZONEDATAFILE lets you specify the path and filename of the data file. This
  77. file contains a list of all the cities and their GMT offsets. The default is
  78. WorldTime.dat (in the current directory). For example,
  79. ZONEDATAFILE=s:times.dat will load the data from s:times.dat.
  80.  
  81.   The data file contains a list, one on each line, of all the cities and
  82. their GMT offsets. You may add as many cities to the file as you wish.
  83. For instance,
  84.  
  85. Adelaide,9.5
  86. Algiers,0
  87. Barbados,-4
  88.  
  89.   This indicates that Adelaide is +9.5 hours from GMT. Algiers is on GMT, and
  90. Barbados is -4 hours from GMT.
  91.  
  92.   You can also specify summer time dates for each city in the list. For
  93. example,
  94.  
  95. Adelaide,9.5,1-Nov,28-Feb
  96.  
  97.   This indicates that daylight savings begins in Adelaide on the first of
  98. November, and ends on the twenty-eighth of February. Note that leap years
  99. are not supported in these calculations, so during a leap year WorldTime
  100. may start or stop summer time one day early (or late). You should also
  101. not specify 29-Feb as either the starting or ending date. When WorldTime
  102. sees that a city is in daylight savings mode, it automatically moves its
  103. clock forward one hour.
  104.  
  105.   WorldTime displays the times in a ListView in a window opened on the
  106. default public screen (normally Workbench). You can scroll through the
  107. times using the arrows or the slider gadget. Underneath the times list
  108. the current local time is displayed. This is updated every second, and
  109. the times list is updated every minute.
  110.  
  111.   If a time has a + sign in front of it, it indicates that the time is
  112. in tomorrow (relative to your current time). If it has a - sign in front of
  113. it, it indicates that the time is in yesterday.
  114.  
  115.   If you press any letter on the keyboard, the time list will jump to display
  116. the first city that begins with that letter. Under Kickstart 39 and greater,
  117. you can use the cursor keys to move up and down the list.
  118.  
  119.   To hide WorldTime, you can either click the close gadget on the WorldTime
  120. window, select Hide from the menu or use the Commodities Exchange controller
  121. program.
  122.  
  123.   If WorldTime is hidden (either by you having hidden it or running it with
  124. CX_POPUP=no), you can make it appear by either hitting the hotkey or using
  125. the Commodities Exchange controller. The hotkey defaults to "lalt ralt w",
  126. meaning both ALT keys held down and W pressed. This can be changed with the
  127. CX_HOTKEY argument.
  128.  
  129.   To quit WorldTime, either use the Remove command in the Exchange controller
  130. or select Quit from the WorldTime menu.
  131.  
  132. -------------------------------------------------------------------------------
  133.  
  134. Revision history :
  135.  
  136. WorldTime 1.0 -> 1.3 :
  137.  
  138.   First versions of WorldTime. Were not font-sensitive (this was the
  139.   biggest complaint about them). Were also limited to 84 entries.
  140.   Did not support daylight savings.
  141.  
  142. WorldTime 2.0 :
  143.  
  144.   Completely rewritten for 2.0. Fully font-sensitive. Allows unlimited
  145.   entries, and supports summer time for each entry. This version was
  146.   never widely released.
  147.  
  148. WorldTime 2.1 :
  149.  
  150.   Fixed a few minor bugs in 2.0, and added keyboard support (any key to
  151.   jump to first city starting with that letter, and cursor key
  152.   support under 39). First public release of version 2.
  153.  
  154. -------------------------------------------------------------------------------
  155.  
  156. Future additions planned :
  157.  
  158.               Multiple, time-zone specific alarms
  159.                (so you will be able to, for instance, have an alarm
  160.                 sound when it is 10:30 am in London)
  161.  
  162.               Locale support (world map?)
  163.  
  164. -------------------------------------------------------------------------------
  165.  
  166.   WorldTime was written with SAS/C 5.10b, by Jonathan Potter. It is freely
  167. distributable, but NOT public domain, and may NOT be sold for profit. It
  168. may also NOT be included on magazine cover disks without the permission of
  169. the author. Any (particularly English) magazines wishing to use this
  170. program MUST contact me first!!!
  171.  
  172.   If you like WorldTime, why not send a donation to encourage the author
  173. to devote more time to freely distributable utilities.
  174.  
  175.   Address author correspondance to :
  176.  
  177.                                Jonathan Potter
  178.                                P.O. Box 289
  179.                                Goodwood, SA 5034
  180.                                Australia
  181.  
  182.                           ph : 61-8-2932788
  183.                          FAX : 61-8-2938941
  184.                      FidoNET : 3:800/805
  185.                     Internet : jpotter@itd.adelaide.edu.au
  186.                   CompuServe : 100033,220
  187.